/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.spark.sql.execution.datasources.geoparquet

import org.apache.spark.sql.execution.datasources.FileFormat
import org.apache.spark.sql.sources.DataSourceRegister

/**
 * Trait of GeoParquetFileFormat defines a method for spatial predicate push down. The actual
 * implementations of GeoParquetFileFormat are in the sql/spark-3.x submodule for specific Spark
 * minor versions.
 */
trait GeoParquetFileFormatBase extends FileFormat with DataSourceRegister {

  override def shortName(): String = "geoparquet"

  /**
   * Create a new GeoParquetFileFormat object with specified spatialFilter
   * @param spatialFilter
   *   spatial filter pushed down to GeoParquetFileFormat
   * @return
   *   a new GeoParquetFileFormat object
   */
  def withSpatialPredicates(spatialFilter: GeoParquetSpatialFilter): GeoParquetFileFormatBase
}
